PaymentAck

This operation transfers the payment acknowledgement against the Certificate Registration application from the the Online Certificate Registration Service to the certifier's IT system.

path Parameters
CaseID
required
string

A fully qualified application number or case id

header Parameters
OrganisationID
required
string

Private Certifier organisation ID

IdempotencyId
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json

body

transactionReference
required
string non-empty

Transaction Reference Number

payerName
required
string non-empty

Payer Name

lGAName
required
string non-empty

LGA Name

amount
required
number

Amount of payment done

paymentTransDate
required
string <date> non-empty

Date of Payment

paymentReference
required
string non-empty

Payment case id

Responses

Request samples

Content type
application/json
{
  • "transactionReference": "string",
  • "payerName": "string",
  • "lGAName": "string",
  • "amount": 0,
  • "paymentTransDate": "2019-08-24",
  • "paymentReference": "P-XXX"
}
Next to CR - ePlanning to Council API